.. role:: bold-underline
        :class: bold-underline

.. _user-management:

User Management
===============

The purpose of this section is to understand the OmniDefend User Management Feature. All user management features can be located by clicking Users in the lefthand pane on the OmniDefend dashboard. See the image below for clarity.

.. image:: /images/users-overview.png

Adding/Removing Users and Editing User Information
++++++++++++++++++++++++++++++++++++++++++++++++++

.. _add-user:

1. Adding a User
----------------

    To add a user, locate the lefthand pane in the OmniDefend Dashboard, and under ``Users``, click ``Add User(s)``. You should see a page titled ``Create a New User``, as seen in the screenshot below.

        .. image:: /images/user-create-new.png

    Fill out all of the fields above. 

        .. tip:: The following fields are optional: ``Office Branch`` and ``Branch Code``

    .. _user-role:

    The ``user role`` field is significant to the access management level of the user. Choose a role from the available list, as depicted in the image below.

        .. image:: /images/user-role-list.png

    Each role has things the user can and can’t do. For more information on ``user role`` privileges, see the table below.

        .. csv-table:: OmniDefend Roles
            :file: /omnidefend-roles-final.csv
            :header-rows: 3
    
    The ``user license`` field is also significant. Left click the field to show any licenses available, and select the license you want that user to be assigned to, as seen in the image below:

        .. image:: /images/add-license.png


        .. tip:: It is possible to add a user without a license. The user will not be allowed to log in and work normally until a license is assigned.

    The ``save password`` field is also significant. If the user does not wish to set a password at this time they would leave this unchecked. By default Password fields will be greyed out when there is no check mark. To set this setting. Click the box then type in a password in the password field and type the same password into the confirm password box. If not checked the new user will need to set a password later. See the image below:

        .. image:: /images/password-set-option.png

    Once all the information has been filled out, the user will have 3 different options to create the user, as seen in the image below:

        .. image:: /images/create-user-options.png

        **Option 1 - ``Create``**

            ``Create`` simply creates the new user and does nothing more.
        
        **Option 2 - ``Create + New``**

            ``Create + New`` is an option to use if you are creating more than one user using this method. It finishes this user creates them and populates the Add new user screen to allow you to fill out for the next user.
        
        **Option 3 - ``Create + Enroll``**

            ``Create + Enroll`` is an option if you are wanting to enroll your user in a device after adding them. In this case it would finish creating the user and take you too enrollment for that user.

.. _add-user-import-template:

2. Adding a User in OmniDefend Import Template Method
-----------------------------------------------------

    To import a new user from a file utilizing a template, click the blue button labelled ``Import from file`` in the top left corner of the ``Add User`` page, as shown below:

        .. image:: /images/import-from-file.png
    
    The next page will direct you to fill in an organization name and choose a file to import. 

        .. tip:: The organization name is important, as some companies have certain users only in certain organizations.

        .. tip:: Click ``here`` below the choose file box to download a sample excel file with an organizational template.

        The sample file should look similar to the image below:

        .. image:: /images/sample-import-file.png
    
    Fill out these 12 fields for 1 user or many users. The sample template shows there are 10 users that will be added. Now that your spreadsheet is filled out copy it somewhere locally and follow the following steps:
    
    Click ``upload`` to finish the import process.

.. _add-user-domain-controller:

3. Adding a User through importing from a domain controller
-----------------------------------------------------------
    To import a user from the domain controller, navigate to the ``add user`` page, and click the button titled ``Import from Directory`` as shown in the picture below:

        .. image:: /images/import-from-file.png
       
    The next page will direct you to fill in an organization name and enter in the domain. 

        .. tip:: The organization name is important, as some companies have certain users only in certain organizations.
    
    The page will then refresh and look similar to the example below. you should now be able to see a list of users from the domain you joined to OmniDefend if it is configured correctly. Left Click on the check box on the left to select a user to import.

        .. image:: /images/domain-controller.png

.. _remove-user:

1. Removing Users in OmniDefend
-------------------------------

    To remove a given user, first navigate to that User's page. Then, as depicted in the image below, find the ``actions`` button to right of Sarah's user picture. Choose the ``Remove User`` option from the dropdown which appears.

        .. image:: /images/actions-remove-user.png
    
    A confirmation box will appear, as shown in the image below. Click ``yes`` to confirm, and ``no`` to cancel and go back to the Users page.

        .. image:: /images/confirmation-box-remove-user.png
    
    After confirmation, the user will be permanently removed from OmniDefend.

    .. image:: /images/OD-Square-Shape-Logo-01.png
        :align: center

.. _user-license:

User Licenses and Email Confirmation
++++++++++++++++++++++++++++++++++++

It is possible that a User may be added without a license. If this is the case, you will see a brown banner at the top of the ``Users`` page like so:

    .. image:: /images/no-license-brown-banner.png

Let's demonstrate how to correct this with example user ``Sarah Freedman``

    On the ``Users`` page, click ``Edit`` to edit profile information, and ``Basic user information`` select the corresponding dropdown to add a license.

        .. image:: /images/add-license.png
    
    .. caution:: If nothing shows in the drop down the user may have not added a license to the server. The user must add a license to their server prior to these steps in order for it to show here.
    
    After selecting a valid license, click the ``Save`` button. If the license was valid, a confirmation message will appear like so:

        .. image:: /images/profile-update-success.png

.. _confirmation-email:

To resend a confirmation, locate the user profile, and select the correct option under the ``Actions`` tab, as demonstrated below.

        .. image:: /images/resend-confirmation-email.png


Check the email for that given user, an activation link will be sent in the form of a link, as seen in the image below.

        .. image:: /images/confirmation-email.png
    
    .. caution:: The activation link will only be valid for 15 minutes. After that time, the process will have to be started over.

The activation link will direct the user to the following page, where they must enter a new password, and confirm that password in the second box.

        .. image:: /images/setting-new-password.png

.. image:: /images/OD-Square-Shape-Logo-01.png
    :align: center

PIN Enrollment and Password Change
++++++++++++++++++++++++++++++++++

.. _change-password:

1. Changing A User’s Password 
-----------------------------

    To change a user's password, navigate to the user's page, and left click on ``actions.`` A drop down box populates, as shown in the image below:

        .. image:: /images/change-password.png

    
    A change password box then populates. 

        .. caution:: Make sure to enter a password not previously used, and confirm the password correctly. Failure to do so will prompt an error message, as shown in the images below:
            
            .. image:: /images/previously-used-password.png
            .. image:: /images/password-bad-match.png

    Upon submission of a valid password, the user should recieve a confirmation email, as shown below:
        
        .. image:: /images/password-change-confirmation.png

.. _enroll-in-PIN:

2. Enrolling a User in OmniDefend PIN

    This section demonstrates how to enroll a user in OmniDefend PIN. First navigate to the User's page (see example Danny Bellows below), and select the ``PIN Authenticator`` icon.
 
        .. image:: /images/authentication-devices-PIN.png

        .. tip:: In the authentication devices section are all the enrollment devices that were set up during server setup.
  
    Next, the user should see a PIN box populate like the screen below:

        .. image:: /images/box-PIN.png
    
    After you type in the new pin and confirm pin, left-click the ``save data`` button.
 
        .. caution:: Please ensure to type the same pin in the new pin and confirm pin or the user will get the error message below:
            
            .. image:: /images/error-PIN.png
        
    Click ``save data`` to save and confirm.